Skip to main content
Version: 3.7

Policy Management

Edit API Pack Name

THAPI Manager allows you to modify a Policy name to have a different name from the present one.

  1. Click the respective usage policy.

usagepolicyeditnew1

The screen appears as shown below.

editpolicyname

  1. Click the Cogwheel icon.

The drop down appears as shown below.

editpolicyname1

  1. Click Edit Policy Name.

Edit Policy Name dialog box appears as shown below.

  1. Enter the Policy Name.

  2. Click Update.

On updating, the confirmation message appears as shown below.

editpolicyname3

Manage Visibility

  1. Click the respective usage policy.

usagepolicyeditnew1

The screen appears as shown below.

editpolicyname

  1. Click the Cogwheel icon.

The drop down appears as shown below.

policyvisibility

  1. Click Manage Visibility.

Usage Policy Visibility dialog box appears as shown below.

  1. Enable/disable the appropriate checkboxes to enable/disable policy visibility to the Publisher Group as per the requirement.

  2. Click Save.

On saving, the confirmation message appears as shown below.

policyvisibility

Submit Usage Policy for Approval

Once you've completed creating and updating a Usage Policy, you can submit it for approval so that it can be assigned to a Plan.

  1. Click the respective usage policy.

usagepolicyeditnew1

The screen appears as shown below.

editpolicyname

  1. Click the Cogwheel icon.

The drop down appears as shown below.

submitpolicyforapproval

  1. Click Submit For Approval.
info

If the login user has the Automatic Approval Workflow enabled, the Approval button will appear instead of Submit For Approval.

  • Click Approve button to approve the policy.

On submitting, the policy is updated and displayed as shown below.

submitpolicyforapproval1

Open an Approved or Published Usage Policy for Editing

You can use Open for Editing if you need to update an approved or published usage policy.

  1. Click the respective usage policy.

submitpolicyfordeprecation

The screen appears as shown below.

submitpolicyfordeprecation1

  1. Click the Cogwheel icon.

The drop down appears as shown below.

openpolicyforediting

  1. Click Open For Editing.

On proceeding, the policy is updated and displayed as shown below.

openpolicyforediting1

info

Once approved, the Policy's status changes to Draft, which enables you to update it.

Submit Usage Policy for Deprecation

A Usage Policy can only be deprecated if it is approved or published.

info

A deprecated usage policy cannot be assigned to a new usage plan. If an approved or published Usage Policy that is associated to a Usage Plan and has active subscribers is selected for deprecation, it will stay in effect until the end of the subscription validity period.

  1. Click the respective usage policy.

submitpolicyfordeprecation

The screen appears as shown below.

submitpolicyfordeprecation1

  1. Click the Cogwheel icon.

The drop down appears as shown below.

submitpolicyfordeprecation2

  1. Click Mark as Deprecate.
info

If the login user has the Automatic Approval Workflow enabled, the Deprecate button will appear instead of Mark as Deprecate.

  • Click Deprecate button to deprecate the policy.

The dialog box appears as shown below.

submitpolicyfordeprecation3

  1. Click OK.

On proceeding, the policy is updated and displayed as shown below.

submitpolicyfordeprecation4

Submit Usage Policy for Retirement

If a Usage Policy is Deprecated, you can retire it. A Policy cannot be attached to a Usage Plan once it has been Retired. A Deprecated Usage Policy that is connected with a Usage Plan cannot be retired.

  1. Click the respective usage policy.

submitpolicyforretire

The screen appears as shown below.

submitpolicyforretire1

  1. Click the Cogwheel icon.

The drop down appears as shown below.

submitpolicyforretire2

  1. Click Submit For Retire.
info

If the login user has the Automatic Approval Workflow enabled, the Retire button will appear instead of Submit For Retire.

  • Click Retire button to deprecate the policy.

The dialog box appears as shown below.

submitpolicyforretire3

  1. Click OK.

On proceeding, the policy is updated and displayed as shown below.

submitpolicyforretire4